Skip to content

docs: add Integration Standards guide#3

Merged
BenHall-1 merged 4 commits into
mainfrom
integration-standards-guide
Apr 26, 2026
Merged

docs: add Integration Standards guide#3
BenHall-1 merged 4 commits into
mainfrom
integration-standards-guide

Conversation

@biast12

@biast12 biast12 commented Apr 25, 2026

Copy link
Copy Markdown
Contributor

Adds INTEGRATION_STANDARDS.md — a prescriptive reference covering everything a public integration in this repo must implement: auth guard, method enforcement, Sentry setup, secrets via request headers, /validate endpoint, INTEGRATION_CACHE KV caching, response format, and wrangler.toml conventions.

Introduce INTEGRATION_STANDARDS.md as the authoritative guide for public integrations hosted by TicketsBot. The document defines mandatory requirements (Authorization guard, POST-only method enforcement, Sentry setup, per-guild secret headers, /validate endpoint, and caching via INTEGRATION_CACHE), response and error formats, wrangler.toml conventions, and recommended practices (jsonResponse helper, input validation, secret format checks). Intended to ensure consistency and security across all integrations in the repository.
@biast12 biast12 requested a review from a team as a code owner April 25, 2026 19:41
biast12 added 3 commits April 25, 2026 21:49
Replace the shared KV namespace id for INTEGRATION_CACHE in INTEGRATION_STANDARDS.md (from 7901ae2b471145d4ab7b8535c158d892 to fbdf23642f6a40d0b5876abf3265910d). Keeps the documented wrangler.toml binding in sync with the current KV namespace.
Clean up markdown formatting by removing extraneous blank lines inside tables in INTEGRATION_STANDARDS.md and README.md. This preserves table rendering and keeps documentation consistent; no substantive content changes were made.
@BenHall-1 BenHall-1 merged commit e2bb691 into main Apr 26, 2026
1 check passed
@BenHall-1 BenHall-1 deleted the integration-standards-guide branch April 26, 2026 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants